ts-markdown-builder 0.2.2 → 0.4.0

package/README.md

@@ -11,9 +11,10 @@ Elegant markdown builder with minimal bundle size.
 ## Goal
 
 TypeScript markdown generation library:
+
 - easy to read and write API
 - build CommonMark & GFM compliant markdown
-- minimal bundle size + tree-shakable 
+- minimal bundle size + tree-shakable
 
 ## Installation
 
@@ -26,7 +27,7 @@ npm install ts-markdown-builder
 ```js
 import * as md from 'ts-markdown-builder';
 
-const output = md.joinBlocks([
+const output = [
   md.heading('Welcome to TS Markdown Builder'),
   "It's an easy to use modern markdown generator.",
   'It supports:',
@@ -37,7 +38,7 @@ const output = md.joinBlocks([
     'blockquotes',
     'and more!',
   ]),
-]);
+].join('\n\n');
 ```
 
 ```markdown
@@ -47,7 +48,7 @@ It's an easy to use modern markdown generator.
 
 It supports:
 
-- **bold** and *italic*
+- **bold** and _italic_
 - \`code\` spans and code blocks
 - unordered and ordered lists
 - blockquotes

package/dist/commonjs/block.js

@@ -8,11 +8,12 @@ exports.list = list;
 exports.orderedList = orderedList;
 var _utils = require("./utils.js");
 const horizontalRule = exports.horizontalRule = '---';
-function heading(text, level = 1) {
+function heading(text, options) {
+  const level = options?.level ?? 1;
   return `${'#'.repeat(level)} ${text}`;
 }
 function blockquote(content) {
-  return (0, _utils.prefixLines)(content, '> ');
+  return (0, _utils.prefixLines)((0, _utils.joinBlocks)(content), '> ');
 }
 function codeBlock(content) {
   return `\`\`\`\n${content}\n\`\`\``;

package/dist/commonjs/block.js.map

@@ -1 +1 @@
-{"version":3,"file":"block.js","names":["horizontalRule","exports","heading","text","level","repeat","blockquote","content","prefixLines","codeBlock","list","items","map","item","join","orderedList","index"],"sources":["../../src/block.ts"],"sourcesContent":["import { prefixLines } from './utils';\n\n/**\n * Create a horizontal rule block.\n *\n * Markdown: `---`\n */\nexport const horizontalRule = '---';\n\n/**\n * Create a heading block.\n * Markdown: `# Heading`\n *\n * @param text - The text of the heading.\n * @param level - The level of the heading (defaults to 1).\n */\nexport function heading(text: string, level: number = 1): string {\n  return `${'#'.repeat(level)} ${text}`;\n}\n\n/**\n * Create a blockquote block.\n *\n * Markdown:\n * ```\n * > Content\n * > Content\n * ```\n *\n * @param text - The content of the blockquote.\n */\nexport function blockquote(content: string): string {\n  return prefixLines(content, '> ');\n}\n\n/**\n * Create a code block.\n *\n * Markdown:\n * ````\n * ```\n * Content\n * ```\n * ````\n *\n * @param content - The content of the code block.\n */\nexport function codeBlock(content: string): string {\n  return `\\`\\`\\`\\n${content}\\n\\`\\`\\``;\n}\n\n/**\n * Create an unordered list block.\n *\n * Markdown:\n * ```\n * - Item\n * - Item\n * ```\n *\n * @param items - The items of the list.\n */\nexport function list(items: readonly string[]): string {\n  return items.map((item) => `- ${item}`).join('\\n');\n}\n\n/**\n * Create an ordered list block.\n *\n * Markdown:\n * ```\n * 1. Item\n * 2. Item\n * ```\n *\n * @param items - The items of the list.\n */\nexport function orderedList(items: readonly string[]): string {\n  return items.map((item, index) => `${index + 1}. ${item}`).join('\\n');\n}\n"],"mappings":";;;;;;;;;AAOO,MAAMA,cAAc,GAAAC,OAAA,CAAAD,cAAA,GAAG,KAAK;AAS5B,SAASE,OAAOA,CAACC,IAAY,EAAEC,KAAa,GAAG,CAAC,EAAU;EAC/D,OAAO,GAAG,GAAG,CAACC,MAAM,CAACD,KAAK,CAAC,IAAID,IAAI,EAAE;AACvC;AAaO,SAASG,UAAUA,CAACC,OAAe,EAAU;EAClD,OAAO,IAAAC,kBAAW,EAACD,OAAO,EAAE,IAAI,CAAC;AACnC;AAcO,SAASE,SAASA,CAACF,OAAe,EAAU;EACjD,OAAO,WAAWA,OAAO,UAAU;AACrC;AAaO,SAASG,IAAIA,CAACC,KAAwB,EAAU;EACrD,OAAOA,KAAK,CAACC,GAAG,CAAEC,IAAI,IAAK,KAAKA,IAAI,EAAE,CAAC,CAACC,IAAI,CAAC,IAAI,CAAC;AACpD;AAaO,SAASC,WAAWA,CAACJ,KAAwB,EAAU;EAC5D,OAAOA,KAAK,CAACC,GAAG,CAAC,CAACC,IAAI,EAAEG,KAAK,KAAK,GAAGA,KAAK,GAAG,CAAC,KAAKH,IAAI,EAAE,CAAC,CAACC,IAAI,CAAC,IAAI,CAAC;AACvE","ignoreList":[]}
+{"version":3,"file":"block.js","names":["horizontalRule","exports","heading","text","options","level","repeat","blockquote","content","prefixLines","joinBlocks","codeBlock","list","items","map","item","join","orderedList","index"],"sources":["../../src/block.ts"],"sourcesContent":["import { joinBlocks, prefixLines } from './utils';\n\n/**\n * Create a horizontal rule block.\n *\n * Markdown: `---`\n */\nexport const horizontalRule = '---';\n\ntype HeadingOptions = {\n  level: number;\n};\n\n/**\n * Create a heading block.\n * Markdown: `# Heading`\n *\n * @param text - The text of the heading.\n * @param level - The level of the heading (defaults to 1).\n */\nexport function heading(text: string, options?: HeadingOptions): string {\n  const level = options?.level ?? 1;\n  return `${'#'.repeat(level)} ${text}`;\n}\n\n/**\n * Create a blockquote block.\n *\n * Markdown:\n * ```\n * > Content\n * > Content\n * ```\n *\n * @param text - The content of the blockquote.\n */\nexport function blockquote(content: string | readonly string[]): string {\n  return prefixLines(joinBlocks(content), '> ');\n}\n\n/**\n * Create a code block.\n *\n * Markdown:\n * ````\n * ```\n * Content\n * ```\n * ````\n *\n * @param content - The content of the code block.\n */\nexport function codeBlock(content: string): string {\n  return `\\`\\`\\`\\n${content}\\n\\`\\`\\``;\n}\n\n/**\n * Create an unordered list block.\n *\n * Markdown:\n * ```\n * - Item\n * - Item\n * ```\n *\n * @param items - The items of the list.\n */\nexport function list(items: readonly string[]): string {\n  return items.map((item) => `- ${item}`).join('\\n');\n}\n\n/**\n * Create an ordered list block.\n *\n * Markdown:\n * ```\n * 1. Item\n * 2. Item\n * ```\n *\n * @param items - The items of the list.\n */\nexport function orderedList(items: readonly string[]): string {\n  return items.map((item, index) => `${index + 1}. ${item}`).join('\\n');\n}\n"],"mappings":";;;;;;;;;AAOO,MAAMA,cAAc,GAAAC,OAAA,CAAAD,cAAA,GAAG,KAAK;AAa5B,SAASE,OAAOA,CAACC,IAAY,EAAEC,OAAwB,EAAU;EACtE,MAAMC,KAAK,GAAGD,OAAO,EAAEC,KAAK,IAAI,CAAC;EACjC,OAAO,GAAG,GAAG,CAACC,MAAM,CAACD,KAAK,CAAC,IAAIF,IAAI,EAAE;AACvC;AAaO,SAASI,UAAUA,CAACC,OAAmC,EAAU;EACtE,OAAO,IAAAC,kBAAW,EAAC,IAAAC,iBAAU,EAACF,OAAO,CAAC,EAAE,IAAI,CAAC;AAC/C;AAcO,SAASG,SAASA,CAACH,OAAe,EAAU;EACjD,OAAO,WAAWA,OAAO,UAAU;AACrC;AAaO,SAASI,IAAIA,CAACC,KAAwB,EAAU;EACrD,OAAOA,KAAK,CAACC,GAAG,CAAEC,IAAI,IAAK,KAAKA,IAAI,EAAE,CAAC,CAACC,IAAI,CAAC,IAAI,CAAC;AACpD;AAaO,SAASC,WAAWA,CAACJ,KAAwB,EAAU;EAC5D,OAAOA,KAAK,CAACC,GAAG,CAAC,CAACC,IAAI,EAAEG,KAAK,KAAK,GAAGA,KAAK,GAAG,CAAC,KAAKH,IAAI,EAAE,CAAC,CAACC,IAAI,CAAC,IAAI,CAAC;AACvE","ignoreList":[]}

package/dist/commonjs/html.js

@@ -7,7 +7,10 @@ function disclosure(title, content, options) {
   const headerHack = title.startsWith('#') ? '\n\n' : '';
   return `<details${options?.open ? ' open' : ''}>
 <summary>${headerHack}${title}${headerHack}</summary>
-\n${content}\n  
+${escapeMarkdownInHtml(content)}
 </details>`;
 }
+function escapeMarkdownInHtml(markdown) {
+  return `\n${markdown}\n`;
+}
 //# sourceMappingURL=html.js.map

package/dist/commonjs/html.js.map

@@ -1 +1 @@
-{"version":3,"file":"html.js","names":["lineBreak","exports","disclosure","title","content","options","headerHack","startsWith","open"],"sources":["../../src/html.ts"],"sourcesContent":["/**\n * Create a line break.\n *\n * Markdown/Html:: `<br/>`\n */\nexport const lineBreak = '<br/>';\n\n/**\n * Options for the `disclosure` block.\n */\nexport type DisclosureOptions = {\n  /**\n   * Whether the disclosure block should be open by default.\n   */\n  open?: boolean;\n};\n\n/**\n * Create a disclosure block.\n *\n * Markdown/Html:\n * ```\n * <details>\n *   <summary>Title</summary>\n *   Content\n * </details>\n * ```\n *\n * @param title - The title of the disclosure.\n * @param content - The content of the disclosure.\n * @param options - The options for the disclosure.\n */\nexport function disclosure(title: string, content: string, options?: DisclosureOptions): string {\n  // Add extra with lines to render header properly. New line should not be added for regular text\n  // as it messes up the formatting.\n  const headerHack = title.startsWith('#') ? '\\n\\n' : '';\n\n  // The extra new lines in <summary> and <details> are required for proper rendering in GitHub.\n  // See https://gist.github.com/scmx/eca72d44afee0113ceb0349dd54a84a2\n  return `<details${options?.open ? ' open' : ''}>\n<summary>${headerHack}${title}${headerHack}</summary>\n\\n${content}\\n  \n</details>`;\n}\n"],"mappings":";;;;AAKO,MAAMA,SAAS,GAAAC,OAAA,CAAAD,SAAA,GAAG,OAAO;AA2BzB,SAASE,UAAUA,CAACC,KAAa,EAAEC,OAAe,EAAEC,OAA2B,EAAU;EAG9F,MAAMC,UAAU,GAAGH,KAAK,CAACI,UAAU,CAAC,GAAG,CAAC,GAAG,MAAM,GAAG,EAAE;EAItD,OAAO,WAAWF,OAAO,EAAEG,IAAI,GAAG,OAAO,GAAG,EAAE;AAChD,WAAWF,UAAU,GAAGH,KAAK,GAAGG,UAAU;AAC1C,IAAIF,OAAO;AACX,WAAW;AACX","ignoreList":[]}
+{"version":3,"file":"html.js","names":["lineBreak","exports","disclosure","title","content","options","headerHack","startsWith","open","escapeMarkdownInHtml","markdown"],"sources":["../../src/html.ts"],"sourcesContent":["/**\n * Create a line break.\n *\n * Markdown (as HTML): `<br/>`\n */\nexport const lineBreak = '<br/>';\n\n/**\n * Options for the `disclosure` block.\n */\nexport type DisclosureOptions = {\n  /**\n   * Whether the disclosure block should be open by default (defaults to false).\n   */\n  open?: boolean;\n};\n\n/**\n * Create a disclosure block.\n *\n * Markdown (as HTML):\n * ```\n * <details>\n *   <summary>Title</summary>\n *   Content\n * </details>\n * ```\n *\n * @param title - The title of the disclosure (text only or markdown heading: `# heading`).\n * @param content - The content of the disclosure (can include markdown).\n * @param options - The options for the disclosure.\n */\nexport function disclosure(title: string, content: string, options?: DisclosureOptions): string {\n  // Add extra with lines to render header properly. New line should not be added for regular text\n  // as it messes up the formatting.\n  const headerHack = title.startsWith('#') ? '\\n\\n' : '';\n\n  return `<details${options?.open ? ' open' : ''}>\n<summary>${headerHack}${title}${headerHack}</summary>\n${escapeMarkdownInHtml(content)}\n</details>`;\n}\n\n// Blank lines are required for rendering a markdown section inside html tag.\n// See https://gist.github.com/scmx/eca72d44afee0113ceb0349dd54a84a2\nfunction escapeMarkdownInHtml(markdown: string): string {\n  return `\\n${markdown}\\n`;\n}\n"],"mappings":";;;;AAKO,MAAMA,SAAS,GAAAC,OAAA,CAAAD,SAAA,GAAG,OAAO;AA2BzB,SAASE,UAAUA,CAACC,KAAa,EAAEC,OAAe,EAAEC,OAA2B,EAAU;EAG9F,MAAMC,UAAU,GAAGH,KAAK,CAACI,UAAU,CAAC,GAAG,CAAC,GAAG,MAAM,GAAG,EAAE;EAEtD,OAAO,WAAWF,OAAO,EAAEG,IAAI,GAAG,OAAO,GAAG,EAAE;AAChD,WAAWF,UAAU,GAAGH,KAAK,GAAGG,UAAU;AAC1C,EAAEG,oBAAoB,CAACL,OAAO,CAAC;AAC/B,WAAW;AACX;AAIA,SAASK,oBAAoBA,CAACC,QAAgB,EAAU;EACtD,OAAO,KAAKA,QAAQ,IAAI;AAC1B","ignoreList":[]}

package/dist/commonjs/index.js

@@ -57,13 +57,7 @@ Object.defineProperty(exports, "italic", {
 Object.defineProperty(exports, "joinBlocks", {
   enumerable: true,
   get: function () {
-    return _join.joinBlocks;
-  }
-});
-Object.defineProperty(exports, "joinLines", {
-  enumerable: true,
-  get: function () {
-    return _join.joinLines;
+    return _utils.joinBlocks;
   }
 });
 Object.defineProperty(exports, "lineBreak", {
@@ -96,9 +90,9 @@ Object.defineProperty(exports, "table", {
     return _table.table;
   }
 });
-var _join = require("./join.js");
 var _block = require("./block.js");
 var _inline = require("./inline.js");
 var _table = require("./table.js");
 var _html = require("./html.js");
+var _utils = require("./utils.js");
 //# sourceMappingURL=index.js.map

package/dist/commonjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"sources":["../../src/index.ts"],"sourcesContent":["export { joinBlocks, joinLines } from './join';\nexport { horizontalRule, heading, blockquote, orderedList, list, codeBlock } from './block';\nexport { code, italic, bold, link, image } from './inline';\nexport { table } from './table';\nexport { lineBreak, disclosure } from './html';\n\nexport type { TableOptions } from './table';\nexport type { DisclosureOptions } from './html';\n"],"mappings":"","ignoreList":[]}
+{"version":3,"file":"index.js","names":[],"sources":["../../src/index.ts"],"sourcesContent":["export { horizontalRule, heading, blockquote, orderedList, list, codeBlock } from './block';\nexport { code, italic, bold, link, image } from './inline';\nexport { table } from './table';\nexport { lineBreak, disclosure } from './html';\nexport { joinBlocks } from './utils';\n\nexport type { TableOptions } from './table';\nexport type { DisclosureOptions } from './html';\n"],"mappings":"","ignoreList":[]}

package/dist/commonjs/inline.js.map

@@ -1 +1 @@
-{"version":3,"file":"inline.js","names":["italic","text","bold","code","link","url","image"],"sources":["../../src/inline.ts"],"sourcesContent":["/**\n * Create an italic text.\n *\n * Markdown: `*text*`\n *\n * @param text - The text to be italicized.\n */\nexport function italic(text: string): string {\n  return `*${text}*`;\n}\n\n/**\n * Create a bold text.\n *\n * Markdown: `**text**`\n *\n * @param text - The text to be bolded.\n */\nexport function bold(text: string): string {\n  return `**${text}**`;\n}\n\n/**\n * Create a code text.\n *\n * Markdown: `\\`text\\``\n *\n * @param text - The text to be marked as code.\n */\nexport function code(text: string): string {\n  return `\\`${text}\\``;\n}\n\n/**\n * Create a link or autolink span.\n *\n * Markdown:\n * - `[text](url)` link when `text` is provided\n * - `<url>` autolink when `text` is not provided\n *\n * @param url - The URL to be linked.\n * @param text - The title for the link (optional).\n */\nexport function link(url: string, text?: string): string {\n  return text ? `[${text}](${url})` : `<${url}>`;\n}\n\n/**\n * Create an image text.\n *\n * Markdown: `![text](url)`\n *\n * @param url - The URL of the image.\n * @param text - The description for the image (optional).\n */\nexport function image(url: string, text?: string): string {\n  return `![${text ?? ''}](${url})`;\n}\n"],"mappings":";;;;;;;AAOO,SAASA,MAAMA,CAACC,IAAY,EAAU;EAC3C,OAAO,IAAIA,IAAI,GAAG;AACpB;AASO,SAASC,IAAIA,CAACD,IAAY,EAAU;EACzC,OAAO,KAAKA,IAAI,IAAI;AACtB;AASO,SAASE,IAAIA,CAACF,IAAY,EAAU;EACzC,OAAO,KAAKA,IAAI,IAAI;AACtB;AAYO,SAASG,IAAIA,CAACC,GAAW,EAAEJ,IAAa,EAAU;EACvD,OAAOA,IAAI,GAAG,IAAIA,IAAI,KAAKI,GAAG,GAAG,GAAG,IAAIA,GAAG,GAAG;AAChD;AAUO,SAASC,KAAKA,CAACD,GAAW,EAAEJ,IAAa,EAAU;EACxD,OAAO,KAAKA,IAAI,IAAI,EAAE,KAAKI,GAAG,GAAG;AACnC","ignoreList":[]}
+{"version":3,"file":"inline.js","names":["italic","text","bold","code","link","url","image"],"sources":["../../src/inline.ts"],"sourcesContent":["/**\n * Create an italic text.\n *\n * Markdown: `*text*`\n *\n * @param text - The text to be italicized.\n */\nexport function italic(text: string): string {\n  return `*${text}*`;\n}\n\n/**\n * Create a bold text.\n *\n * Markdown: `**text**`\n *\n * @param text - The text to be bolded.\n */\nexport function bold(text: string): string {\n  return `**${text}**`;\n}\n\n/**\n * Create a code text.\n *\n * Markdown: `code`\n *\n * @param text - The text to be marked as code.\n */\nexport function code(text: string): string {\n  return `\\`${text}\\``;\n}\n\n/**\n * Create a link or autolink span.\n *\n * Markdown:\n * - `[text](url)` link when `text` is provided\n * - `<url>` autolink when `text` is not provided\n *\n * @param url - The URL to be linked.\n * @param text - The title for the link (optional).\n */\nexport function link(url: string, text?: string): string {\n  return text ? `[${text}](${url})` : `<${url}>`;\n}\n\n/**\n * Create an image text.\n *\n * Markdown: `![text](url)`\n *\n * @param url - The URL of the image.\n * @param text - The description for the image (optional).\n */\nexport function image(url: string, text?: string): string {\n  return `![${text ?? ''}](${url})`;\n}\n"],"mappings":";;;;;;;AAOO,SAASA,MAAMA,CAACC,IAAY,EAAU;EAC3C,OAAO,IAAIA,IAAI,GAAG;AACpB;AASO,SAASC,IAAIA,CAACD,IAAY,EAAU;EACzC,OAAO,KAAKA,IAAI,IAAI;AACtB;AASO,SAASE,IAAIA,CAACF,IAAY,EAAU;EACzC,OAAO,KAAKA,IAAI,IAAI;AACtB;AAYO,SAASG,IAAIA,CAACC,GAAW,EAAEJ,IAAa,EAAU;EACvD,OAAOA,IAAI,GAAG,IAAIA,IAAI,KAAKI,GAAG,GAAG,GAAG,IAAIA,GAAG,GAAG;AAChD;AAUO,SAASC,KAAKA,CAACD,GAAW,EAAEJ,IAAa,EAAU;EACxD,OAAO,KAAKA,IAAI,IAAI,EAAE,KAAKI,GAAG,GAAG;AACnC","ignoreList":[]}

package/dist/commonjs/utils.js

@@ -1,6 +1,14 @@
 "use strict";
 
+exports.joinBlocks = joinBlocks;
 exports.prefixLines = prefixLines;
+function joinBlocks(blocks) {
+  blocks = typeof blocks === 'string' ? [blocks] : blocks;
+  return blocks.map(trimBlock).filter(Boolean).join('\n\n');
+}
+function trimBlock(block) {
+  return block.replace(/^\n+|\n+$/g, '');
+}
 function prefixLines(text, prefix) {
   const lines = text.split('\n');
   return lines.map(line => `${prefix}${line}`).join('\n');

package/dist/commonjs/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","names":["prefixLines","text","prefix","lines","split","map","line","join"],"sources":["../../src/utils.ts"],"sourcesContent":["export function prefixLines(text: string, prefix: string): string {\n  const lines = text.split('\\n');\n  return lines.map((line) => `${prefix}${line}`).join('\\n');\n}\n"],"mappings":";;;AAAO,SAASA,WAAWA,CAACC,IAAY,EAAEC,MAAc,EAAU;EAChE,MAAMC,KAAK,GAAGF,IAAI,CAACG,KAAK,CAAC,IAAI,CAAC;EAC9B,OAAOD,KAAK,CAACE,GAAG,CAAEC,IAAI,IAAK,GAAGJ,MAAM,GAAGI,IAAI,EAAE,CAAC,CAACC,IAAI,CAAC,IAAI,CAAC;AAC3D","ignoreList":[]}
+{"version":3,"file":"utils.js","names":["joinBlocks","blocks","map","trimBlock","filter","Boolean","join","block","replace","prefixLines","text","prefix","lines","split","line"],"sources":["../../src/utils.ts"],"sourcesContent":["/**\n * Join blocks of text into a single markdown document (string).\n *\n * @param blocks - The blocks of text to join.\n * @returns Markdown document string.\n */\nexport function joinBlocks(blocks: string | readonly string[]): string {\n  blocks = typeof blocks === 'string' ? [blocks] : blocks;\n\n  return blocks.map(trimBlock).filter(Boolean).join('\\n\\n');\n}\n\nfunction trimBlock(block: string): string {\n  return block.replace(/^\\n+|\\n+$/g, '');\n}\n\nexport function prefixLines(text: string, prefix: string): string {\n  const lines = text.split('\\n');\n  return lines.map((line) => `${prefix}${line}`).join('\\n');\n}\n"],"mappings":";;;;AAMO,SAASA,UAAUA,CAACC,MAAkC,EAAU;EACrEA,MAAM,GAAG,OAAOA,MAAM,KAAK,QAAQ,GAAG,CAACA,MAAM,CAAC,GAAGA,MAAM;EAEvD,OAAOA,MAAM,CAACC,GAAG,CAACC,SAAS,CAAC,CAACC,MAAM,CAACC,OAAO,CAAC,CAACC,IAAI,CAAC,MAAM,CAAC;AAC3D;AAEA,SAASH,SAASA,CAACI,KAAa,EAAU;EACxC,OAAOA,KAAK,CAACC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC;AACxC;AAEO,SAASC,WAAWA,CAACC,IAAY,EAAEC,MAAc,EAAU;EAChE,MAAMC,KAAK,GAAGF,IAAI,CAACG,KAAK,CAAC,IAAI,CAAC;EAC9B,OAAOD,KAAK,CAACV,GAAG,CAAEY,IAAI,IAAK,GAAGH,MAAM,GAAGG,IAAI,EAAE,CAAC,CAACR,IAAI,CAAC,IAAI,CAAC;AAC3D","ignoreList":[]}

package/dist/esm/block.mjs

@@ -1,10 +1,11 @@
-import { prefixLines } from "./utils.mjs";
+import { joinBlocks, prefixLines } from "./utils.mjs";
 export const horizontalRule = '---';
-export function heading(text, level = 1) {
+export function heading(text, options) {
+  const level = options?.level ?? 1;
   return `${'#'.repeat(level)} ${text}`;
 }
 export function blockquote(content) {
-  return prefixLines(content, '> ');
+  return prefixLines(joinBlocks(content), '> ');
 }
 export function codeBlock(content) {
   return `\`\`\`\n${content}\n\`\`\``;

package/dist/esm/block.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"block.mjs","names":["prefixLines","horizontalRule","heading","text","level","repeat","blockquote","content","codeBlock","list","items","map","item","join","orderedList","index"],"sources":["../../src/block.ts"],"sourcesContent":["import { prefixLines } from './utils';\n\n/**\n * Create a horizontal rule block.\n *\n * Markdown: `---`\n */\nexport const horizontalRule = '---';\n\n/**\n * Create a heading block.\n * Markdown: `# Heading`\n *\n * @param text - The text of the heading.\n * @param level - The level of the heading (defaults to 1).\n */\nexport function heading(text: string, level: number = 1): string {\n  return `${'#'.repeat(level)} ${text}`;\n}\n\n/**\n * Create a blockquote block.\n *\n * Markdown:\n * ```\n * > Content\n * > Content\n * ```\n *\n * @param text - The content of the blockquote.\n */\nexport function blockquote(content: string): string {\n  return prefixLines(content, '> ');\n}\n\n/**\n * Create a code block.\n *\n * Markdown:\n * ````\n * ```\n * Content\n * ```\n * ````\n *\n * @param content - The content of the code block.\n */\nexport function codeBlock(content: string): string {\n  return `\\`\\`\\`\\n${content}\\n\\`\\`\\``;\n}\n\n/**\n * Create an unordered list block.\n *\n * Markdown:\n * ```\n * - Item\n * - Item\n * ```\n *\n * @param items - The items of the list.\n */\nexport function list(items: readonly string[]): string {\n  return items.map((item) => `- ${item}`).join('\\n');\n}\n\n/**\n * Create an ordered list block.\n *\n * Markdown:\n * ```\n * 1. Item\n * 2. Item\n * ```\n *\n * @param items - The items of the list.\n */\nexport function orderedList(items: readonly string[]): string {\n  return items.map((item, index) => `${index + 1}. ${item}`).join('\\n');\n}\n"],"mappings":"SAASA,WAAW;AAOpB,OAAO,MAAMC,cAAc,GAAG,KAAK;AASnC,OAAO,SAASC,OAAOA,CAACC,IAAY,EAAEC,KAAa,GAAG,CAAC,EAAU;EAC/D,OAAO,GAAG,GAAG,CAACC,MAAM,CAACD,KAAK,CAAC,IAAID,IAAI,EAAE;AACvC;AAaA,OAAO,SAASG,UAAUA,CAACC,OAAe,EAAU;EAClD,OAAOP,WAAW,CAACO,OAAO,EAAE,IAAI,CAAC;AACnC;AAcA,OAAO,SAASC,SAASA,CAACD,OAAe,EAAU;EACjD,OAAO,WAAWA,OAAO,UAAU;AACrC;AAaA,OAAO,SAASE,IAAIA,CAACC,KAAwB,EAAU;EACrD,OAAOA,KAAK,CAACC,GAAG,CAAEC,IAAI,IAAK,KAAKA,IAAI,EAAE,CAAC,CAACC,IAAI,CAAC,IAAI,CAAC;AACpD;AAaA,OAAO,SAASC,WAAWA,CAACJ,KAAwB,EAAU;EAC5D,OAAOA,KAAK,CAACC,GAAG,CAAC,CAACC,IAAI,EAAEG,KAAK,KAAK,GAAGA,KAAK,GAAG,CAAC,KAAKH,IAAI,EAAE,CAAC,CAACC,IAAI,CAAC,IAAI,CAAC;AACvE","ignoreList":[]}
+{"version":3,"file":"block.mjs","names":["joinBlocks","prefixLines","horizontalRule","heading","text","options","level","repeat","blockquote","content","codeBlock","list","items","map","item","join","orderedList","index"],"sources":["../../src/block.ts"],"sourcesContent":["import { joinBlocks, prefixLines } from './utils';\n\n/**\n * Create a horizontal rule block.\n *\n * Markdown: `---`\n */\nexport const horizontalRule = '---';\n\ntype HeadingOptions = {\n  level: number;\n};\n\n/**\n * Create a heading block.\n * Markdown: `# Heading`\n *\n * @param text - The text of the heading.\n * @param level - The level of the heading (defaults to 1).\n */\nexport function heading(text: string, options?: HeadingOptions): string {\n  const level = options?.level ?? 1;\n  return `${'#'.repeat(level)} ${text}`;\n}\n\n/**\n * Create a blockquote block.\n *\n * Markdown:\n * ```\n * > Content\n * > Content\n * ```\n *\n * @param text - The content of the blockquote.\n */\nexport function blockquote(content: string | readonly string[]): string {\n  return prefixLines(joinBlocks(content), '> ');\n}\n\n/**\n * Create a code block.\n *\n * Markdown:\n * ````\n * ```\n * Content\n * ```\n * ````\n *\n * @param content - The content of the code block.\n */\nexport function codeBlock(content: string): string {\n  return `\\`\\`\\`\\n${content}\\n\\`\\`\\``;\n}\n\n/**\n * Create an unordered list block.\n *\n * Markdown:\n * ```\n * - Item\n * - Item\n * ```\n *\n * @param items - The items of the list.\n */\nexport function list(items: readonly string[]): string {\n  return items.map((item) => `- ${item}`).join('\\n');\n}\n\n/**\n * Create an ordered list block.\n *\n * Markdown:\n * ```\n * 1. Item\n * 2. Item\n * ```\n *\n * @param items - The items of the list.\n */\nexport function orderedList(items: readonly string[]): string {\n  return items.map((item, index) => `${index + 1}. ${item}`).join('\\n');\n}\n"],"mappings":"SAASA,UAAU,EAAEC,WAAW;AAOhC,OAAO,MAAMC,cAAc,GAAG,KAAK;AAanC,OAAO,SAASC,OAAOA,CAACC,IAAY,EAAEC,OAAwB,EAAU;EACtE,MAAMC,KAAK,GAAGD,OAAO,EAAEC,KAAK,IAAI,CAAC;EACjC,OAAO,GAAG,GAAG,CAACC,MAAM,CAACD,KAAK,CAAC,IAAIF,IAAI,EAAE;AACvC;AAaA,OAAO,SAASI,UAAUA,CAACC,OAAmC,EAAU;EACtE,OAAOR,WAAW,CAACD,UAAU,CAACS,OAAO,CAAC,EAAE,IAAI,CAAC;AAC/C;AAcA,OAAO,SAASC,SAASA,CAACD,OAAe,EAAU;EACjD,OAAO,WAAWA,OAAO,UAAU;AACrC;AAaA,OAAO,SAASE,IAAIA,CAACC,KAAwB,EAAU;EACrD,OAAOA,KAAK,CAACC,GAAG,CAAEC,IAAI,IAAK,KAAKA,IAAI,EAAE,CAAC,CAACC,IAAI,CAAC,IAAI,CAAC;AACpD;AAaA,OAAO,SAASC,WAAWA,CAACJ,KAAwB,EAAU;EAC5D,OAAOA,KAAK,CAACC,GAAG,CAAC,CAACC,IAAI,EAAEG,KAAK,KAAK,GAAGA,KAAK,GAAG,CAAC,KAAKH,IAAI,EAAE,CAAC,CAACC,IAAI,CAAC,IAAI,CAAC;AACvE","ignoreList":[]}

package/dist/esm/html.mjs

@@ -3,7 +3,10 @@ export function disclosure(title, content, options) {
   const headerHack = title.startsWith('#') ? '\n\n' : '';
   return `<details${options?.open ? ' open' : ''}>
 <summary>${headerHack}${title}${headerHack}</summary>
-\n${content}\n  
+${escapeMarkdownInHtml(content)}
 </details>`;
 }
+function escapeMarkdownInHtml(markdown) {
+  return `\n${markdown}\n`;
+}
 //# sourceMappingURL=html.mjs.map

package/dist/esm/html.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"html.mjs","names":["lineBreak","disclosure","title","content","options","headerHack","startsWith","open"],"sources":["../../src/html.ts"],"sourcesContent":["/**\n * Create a line break.\n *\n * Markdown/Html:: `<br/>`\n */\nexport const lineBreak = '<br/>';\n\n/**\n * Options for the `disclosure` block.\n */\nexport type DisclosureOptions = {\n  /**\n   * Whether the disclosure block should be open by default.\n   */\n  open?: boolean;\n};\n\n/**\n * Create a disclosure block.\n *\n * Markdown/Html:\n * ```\n * <details>\n *   <summary>Title</summary>\n *   Content\n * </details>\n * ```\n *\n * @param title - The title of the disclosure.\n * @param content - The content of the disclosure.\n * @param options - The options for the disclosure.\n */\nexport function disclosure(title: string, content: string, options?: DisclosureOptions): string {\n  // Add extra with lines to render header properly. New line should not be added for regular text\n  // as it messes up the formatting.\n  const headerHack = title.startsWith('#') ? '\\n\\n' : '';\n\n  // The extra new lines in <summary> and <details> are required for proper rendering in GitHub.\n  // See https://gist.github.com/scmx/eca72d44afee0113ceb0349dd54a84a2\n  return `<details${options?.open ? ' open' : ''}>\n<summary>${headerHack}${title}${headerHack}</summary>\n\\n${content}\\n  \n</details>`;\n}\n"],"mappings":"AAKA,OAAO,MAAMA,SAAS,GAAG,OAAO;AA2BhC,OAAO,SAASC,UAAUA,CAACC,KAAa,EAAEC,OAAe,EAAEC,OAA2B,EAAU;EAG9F,MAAMC,UAAU,GAAGH,KAAK,CAACI,UAAU,CAAC,GAAG,CAAC,GAAG,MAAM,GAAG,EAAE;EAItD,OAAO,WAAWF,OAAO,EAAEG,IAAI,GAAG,OAAO,GAAG,EAAE;AAChD,WAAWF,UAAU,GAAGH,KAAK,GAAGG,UAAU;AAC1C,IAAIF,OAAO;AACX,WAAW;AACX","ignoreList":[]}
+{"version":3,"file":"html.mjs","names":["lineBreak","disclosure","title","content","options","headerHack","startsWith","open","escapeMarkdownInHtml","markdown"],"sources":["../../src/html.ts"],"sourcesContent":["/**\n * Create a line break.\n *\n * Markdown (as HTML): `<br/>`\n */\nexport const lineBreak = '<br/>';\n\n/**\n * Options for the `disclosure` block.\n */\nexport type DisclosureOptions = {\n  /**\n   * Whether the disclosure block should be open by default (defaults to false).\n   */\n  open?: boolean;\n};\n\n/**\n * Create a disclosure block.\n *\n * Markdown (as HTML):\n * ```\n * <details>\n *   <summary>Title</summary>\n *   Content\n * </details>\n * ```\n *\n * @param title - The title of the disclosure (text only or markdown heading: `# heading`).\n * @param content - The content of the disclosure (can include markdown).\n * @param options - The options for the disclosure.\n */\nexport function disclosure(title: string, content: string, options?: DisclosureOptions): string {\n  // Add extra with lines to render header properly. New line should not be added for regular text\n  // as it messes up the formatting.\n  const headerHack = title.startsWith('#') ? '\\n\\n' : '';\n\n  return `<details${options?.open ? ' open' : ''}>\n<summary>${headerHack}${title}${headerHack}</summary>\n${escapeMarkdownInHtml(content)}\n</details>`;\n}\n\n// Blank lines are required for rendering a markdown section inside html tag.\n// See https://gist.github.com/scmx/eca72d44afee0113ceb0349dd54a84a2\nfunction escapeMarkdownInHtml(markdown: string): string {\n  return `\\n${markdown}\\n`;\n}\n"],"mappings":"AAKA,OAAO,MAAMA,SAAS,GAAG,OAAO;AA2BhC,OAAO,SAASC,UAAUA,CAACC,KAAa,EAAEC,OAAe,EAAEC,OAA2B,EAAU;EAG9F,MAAMC,UAAU,GAAGH,KAAK,CAACI,UAAU,CAAC,GAAG,CAAC,GAAG,MAAM,GAAG,EAAE;EAEtD,OAAO,WAAWF,OAAO,EAAEG,IAAI,GAAG,OAAO,GAAG,EAAE;AAChD,WAAWF,UAAU,GAAGH,KAAK,GAAGG,UAAU;AAC1C,EAAEG,oBAAoB,CAACL,OAAO,CAAC;AAC/B,WAAW;AACX;AAIA,SAASK,oBAAoBA,CAACC,QAAgB,EAAU;EACtD,OAAO,KAAKA,QAAQ,IAAI;AAC1B","ignoreList":[]}

package/dist/esm/index.mjs

@@ -1,6 +1,6 @@
-export { joinBlocks, joinLines } from "./join.mjs";
 export { horizontalRule, heading, blockquote, orderedList, list, codeBlock } from "./block.mjs";
 export { code, italic, bold, link, image } from "./inline.mjs";
 export { table } from "./table.mjs";
 export { lineBreak, disclosure } from "./html.mjs";
+export { joinBlocks } from "./utils.mjs";
 //# sourceMappingURL=index.mjs.map

package/dist/esm/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","names":["joinBlocks","joinLines","horizontalRule","heading","blockquote","orderedList","list","codeBlock","code","italic","bold","link","image","table","lineBreak","disclosure"],"sources":["../../src/index.ts"],"sourcesContent":["export { joinBlocks, joinLines } from './join';\nexport { horizontalRule, heading, blockquote, orderedList, list, codeBlock } from './block';\nexport { code, italic, bold, link, image } from './inline';\nexport { table } from './table';\nexport { lineBreak, disclosure } from './html';\n\nexport type { TableOptions } from './table';\nexport type { DisclosureOptions } from './html';\n"],"mappings":"SAASA,UAAU,EAAEC,SAAS;AAAA,SACrBC,cAAc,EAAEC,OAAO,EAAEC,UAAU,EAAEC,WAAW,EAAEC,IAAI,EAAEC,SAAS;AAAA,SACjEC,IAAI,EAAEC,MAAM,EAAEC,IAAI,EAAEC,IAAI,EAAEC,KAAK;AAAA,SAC/BC,KAAK;AAAA,SACLC,SAAS,EAAEC,UAAU","ignoreList":[]}
+{"version":3,"file":"index.mjs","names":["horizontalRule","heading","blockquote","orderedList","list","codeBlock","code","italic","bold","link","image","table","lineBreak","disclosure","joinBlocks"],"sources":["../../src/index.ts"],"sourcesContent":["export { horizontalRule, heading, blockquote, orderedList, list, codeBlock } from './block';\nexport { code, italic, bold, link, image } from './inline';\nexport { table } from './table';\nexport { lineBreak, disclosure } from './html';\nexport { joinBlocks } from './utils';\n\nexport type { TableOptions } from './table';\nexport type { DisclosureOptions } from './html';\n"],"mappings":"SAASA,cAAc,EAAEC,OAAO,EAAEC,UAAU,EAAEC,WAAW,EAAEC,IAAI,EAAEC,SAAS;AAAA,SACjEC,IAAI,EAAEC,MAAM,EAAEC,IAAI,EAAEC,IAAI,EAAEC,KAAK;AAAA,SAC/BC,KAAK;AAAA,SACLC,SAAS,EAAEC,UAAU;AAAA,SACrBC,UAAU","ignoreList":[]}

package/dist/esm/inline.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"inline.mjs","names":["italic","text","bold","code","link","url","image"],"sources":["../../src/inline.ts"],"sourcesContent":["/**\n * Create an italic text.\n *\n * Markdown: `*text*`\n *\n * @param text - The text to be italicized.\n */\nexport function italic(text: string): string {\n  return `*${text}*`;\n}\n\n/**\n * Create a bold text.\n *\n * Markdown: `**text**`\n *\n * @param text - The text to be bolded.\n */\nexport function bold(text: string): string {\n  return `**${text}**`;\n}\n\n/**\n * Create a code text.\n *\n * Markdown: `\\`text\\``\n *\n * @param text - The text to be marked as code.\n */\nexport function code(text: string): string {\n  return `\\`${text}\\``;\n}\n\n/**\n * Create a link or autolink span.\n *\n * Markdown:\n * - `[text](url)` link when `text` is provided\n * - `<url>` autolink when `text` is not provided\n *\n * @param url - The URL to be linked.\n * @param text - The title for the link (optional).\n */\nexport function link(url: string, text?: string): string {\n  return text ? `[${text}](${url})` : `<${url}>`;\n}\n\n/**\n * Create an image text.\n *\n * Markdown: `![text](url)`\n *\n * @param url - The URL of the image.\n * @param text - The description for the image (optional).\n */\nexport function image(url: string, text?: string): string {\n  return `![${text ?? ''}](${url})`;\n}\n"],"mappings":"AAOA,OAAO,SAASA,MAAMA,CAACC,IAAY,EAAU;EAC3C,OAAO,IAAIA,IAAI,GAAG;AACpB;AASA,OAAO,SAASC,IAAIA,CAACD,IAAY,EAAU;EACzC,OAAO,KAAKA,IAAI,IAAI;AACtB;AASA,OAAO,SAASE,IAAIA,CAACF,IAAY,EAAU;EACzC,OAAO,KAAKA,IAAI,IAAI;AACtB;AAYA,OAAO,SAASG,IAAIA,CAACC,GAAW,EAAEJ,IAAa,EAAU;EACvD,OAAOA,IAAI,GAAG,IAAIA,IAAI,KAAKI,GAAG,GAAG,GAAG,IAAIA,GAAG,GAAG;AAChD;AAUA,OAAO,SAASC,KAAKA,CAACD,GAAW,EAAEJ,IAAa,EAAU;EACxD,OAAO,KAAKA,IAAI,IAAI,EAAE,KAAKI,GAAG,GAAG;AACnC","ignoreList":[]}
+{"version":3,"file":"inline.mjs","names":["italic","text","bold","code","link","url","image"],"sources":["../../src/inline.ts"],"sourcesContent":["/**\n * Create an italic text.\n *\n * Markdown: `*text*`\n *\n * @param text - The text to be italicized.\n */\nexport function italic(text: string): string {\n  return `*${text}*`;\n}\n\n/**\n * Create a bold text.\n *\n * Markdown: `**text**`\n *\n * @param text - The text to be bolded.\n */\nexport function bold(text: string): string {\n  return `**${text}**`;\n}\n\n/**\n * Create a code text.\n *\n * Markdown: `code`\n *\n * @param text - The text to be marked as code.\n */\nexport function code(text: string): string {\n  return `\\`${text}\\``;\n}\n\n/**\n * Create a link or autolink span.\n *\n * Markdown:\n * - `[text](url)` link when `text` is provided\n * - `<url>` autolink when `text` is not provided\n *\n * @param url - The URL to be linked.\n * @param text - The title for the link (optional).\n */\nexport function link(url: string, text?: string): string {\n  return text ? `[${text}](${url})` : `<${url}>`;\n}\n\n/**\n * Create an image text.\n *\n * Markdown: `![text](url)`\n *\n * @param url - The URL of the image.\n * @param text - The description for the image (optional).\n */\nexport function image(url: string, text?: string): string {\n  return `![${text ?? ''}](${url})`;\n}\n"],"mappings":"AAOA,OAAO,SAASA,MAAMA,CAACC,IAAY,EAAU;EAC3C,OAAO,IAAIA,IAAI,GAAG;AACpB;AASA,OAAO,SAASC,IAAIA,CAACD,IAAY,EAAU;EACzC,OAAO,KAAKA,IAAI,IAAI;AACtB;AASA,OAAO,SAASE,IAAIA,CAACF,IAAY,EAAU;EACzC,OAAO,KAAKA,IAAI,IAAI;AACtB;AAYA,OAAO,SAASG,IAAIA,CAACC,GAAW,EAAEJ,IAAa,EAAU;EACvD,OAAOA,IAAI,GAAG,IAAIA,IAAI,KAAKI,GAAG,GAAG,GAAG,IAAIA,GAAG,GAAG;AAChD;AAUA,OAAO,SAASC,KAAKA,CAACD,GAAW,EAAEJ,IAAa,EAAU;EACxD,OAAO,KAAKA,IAAI,IAAI,EAAE,KAAKI,GAAG,GAAG;AACnC","ignoreList":[]}

package/dist/esm/utils.mjs

@@ -1,3 +1,10 @@
+export function joinBlocks(blocks) {
+  blocks = typeof blocks === 'string' ? [blocks] : blocks;
+  return blocks.map(trimBlock).filter(Boolean).join('\n\n');
+}
+function trimBlock(block) {
+  return block.replace(/^\n+|\n+$/g, '');
+}
 export function prefixLines(text, prefix) {
   const lines = text.split('\n');
   return lines.map(line => `${prefix}${line}`).join('\n');

package/dist/esm/utils.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"utils.mjs","names":["prefixLines","text","prefix","lines","split","map","line","join"],"sources":["../../src/utils.ts"],"sourcesContent":["export function prefixLines(text: string, prefix: string): string {\n  const lines = text.split('\\n');\n  return lines.map((line) => `${prefix}${line}`).join('\\n');\n}\n"],"mappings":"AAAA,OAAO,SAASA,WAAWA,CAACC,IAAY,EAAEC,MAAc,EAAU;EAChE,MAAMC,KAAK,GAAGF,IAAI,CAACG,KAAK,CAAC,IAAI,CAAC;EAC9B,OAAOD,KAAK,CAACE,GAAG,CAAEC,IAAI,IAAK,GAAGJ,MAAM,GAAGI,IAAI,EAAE,CAAC,CAACC,IAAI,CAAC,IAAI,CAAC;AAC3D","ignoreList":[]}
+{"version":3,"file":"utils.mjs","names":["joinBlocks","blocks","map","trimBlock","filter","Boolean","join","block","replace","prefixLines","text","prefix","lines","split","line"],"sources":["../../src/utils.ts"],"sourcesContent":["/**\n * Join blocks of text into a single markdown document (string).\n *\n * @param blocks - The blocks of text to join.\n * @returns Markdown document string.\n */\nexport function joinBlocks(blocks: string | readonly string[]): string {\n  blocks = typeof blocks === 'string' ? [blocks] : blocks;\n\n  return blocks.map(trimBlock).filter(Boolean).join('\\n\\n');\n}\n\nfunction trimBlock(block: string): string {\n  return block.replace(/^\\n+|\\n+$/g, '');\n}\n\nexport function prefixLines(text: string, prefix: string): string {\n  const lines = text.split('\\n');\n  return lines.map((line) => `${prefix}${line}`).join('\\n');\n}\n"],"mappings":"AAMA,OAAO,SAASA,UAAUA,CAACC,MAAkC,EAAU;EACrEA,MAAM,GAAG,OAAOA,MAAM,KAAK,QAAQ,GAAG,CAACA,MAAM,CAAC,GAAGA,MAAM;EAEvD,OAAOA,MAAM,CAACC,GAAG,CAACC,SAAS,CAAC,CAACC,MAAM,CAACC,OAAO,CAAC,CAACC,IAAI,CAAC,MAAM,CAAC;AAC3D;AAEA,SAASH,SAASA,CAACI,KAAa,EAAU;EACxC,OAAOA,KAAK,CAACC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC;AACxC;AAEA,OAAO,SAASC,WAAWA,CAACC,IAAY,EAAEC,MAAc,EAAU;EAChE,MAAMC,KAAK,GAAGF,IAAI,CAACG,KAAK,CAAC,IAAI,CAAC;EAC9B,OAAOD,KAAK,CAACV,GAAG,CAAEY,IAAI,IAAK,GAAGH,MAAM,GAAGG,IAAI,EAAE,CAAC,CAACR,IAAI,CAAC,IAAI,CAAC;AAC3D","ignoreList":[]}

package/dist/types/block.d.ts

@@ -4,6 +4,9 @@
  * Markdown: `---`
  */
 export declare const horizontalRule = "---";
+type HeadingOptions = {
+    level: number;
+};
 /**
  * Create a heading block.
  * Markdown: `# Heading`
@@ -11,7 +14,7 @@ export declare const horizontalRule = "---";
  * @param text - The text of the heading.
  * @param level - The level of the heading (defaults to 1).
  */
-export declare function heading(text: string, level?: number): string;
+export declare function heading(text: string, options?: HeadingOptions): string;
 /**
  * Create a blockquote block.
  *
@@ -23,7 +26,7 @@ export declare function heading(text: string, level?: number): string;
  *
  * @param text - The content of the blockquote.
  */
-export declare function blockquote(content: string): string;
+export declare function blockquote(content: string | readonly string[]): string;
 /**
  * Create a code block.
  *
@@ -61,3 +64,4 @@ export declare function list(items: readonly string[]): string;
  * @param items - The items of the list.
  */
 export declare function orderedList(items: readonly string[]): string;
+export {};

package/dist/types/html.d.ts

@@ -1,7 +1,7 @@
 /**
  * Create a line break.
  *
- * Markdown/Html:: `<br/>`
+ * Markdown (as HTML): `<br/>`
  */
 export declare const lineBreak = "<br/>";
 /**
@@ -9,14 +9,14 @@ export declare const lineBreak = "<br/>";
  */
 export type DisclosureOptions = {
     /**
-     * Whether the disclosure block should be open by default.
+     * Whether the disclosure block should be open by default (defaults to false).
      */
     open?: boolean;
 };
 /**
  * Create a disclosure block.
  *
- * Markdown/Html:
+ * Markdown (as HTML):
  * ```
  * <details>
  *   <summary>Title</summary>
@@ -24,8 +24,8 @@ export type DisclosureOptions = {
  * </details>
  * ```
  *
- * @param title - The title of the disclosure.
- * @param content - The content of the disclosure.
+ * @param title - The title of the disclosure (text only or markdown heading: `# heading`).
+ * @param content - The content of the disclosure (can include markdown).
  * @param options - The options for the disclosure.
  */
 export declare function disclosure(title: string, content: string, options?: DisclosureOptions): string;

package/dist/types/index.d.ts

@@ -1,7 +1,7 @@
-export { joinBlocks, joinLines } from './join';
 export { horizontalRule, heading, blockquote, orderedList, list, codeBlock } from './block';
 export { code, italic, bold, link, image } from './inline';
 export { table } from './table';
 export { lineBreak, disclosure } from './html';
+export { joinBlocks } from './utils';
 export type { TableOptions } from './table';
 export type { DisclosureOptions } from './html';

package/dist/types/inline.d.ts

@@ -17,7 +17,7 @@ export declare function bold(text: string): string;
 /**
  * Create a code text.
  *
- * Markdown: `\`text\``
+ * Markdown: `code`
  *
  * @param text - The text to be marked as code.
  */

package/dist/types/utils.d.ts

@@ -1 +1,8 @@
+/**
+ * Join blocks of text into a single markdown document (string).
+ *
+ * @param blocks - The blocks of text to join.
+ * @returns Markdown document string.
+ */
+export declare function joinBlocks(blocks: string | readonly string[]): string;
 export declare function prefixLines(text: string, prefix: string): string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-markdown-builder",
-  "version": "0.2.2",
+  "version": "0.4.0",
   "description": "Elegant markdown builder with minimal bundle size.",
   "main": "dist/commonjs/index.js",
   "module": "dist/esm/index.mjs",
@@ -24,12 +24,12 @@
     "typecheck": "tsc --noEmit",
     "lint": "eslint \"**/*.{js,ts,tsx}\"",
     "clean": "del-cli dist",
-    "release": "release-it",
-    "release:beta": "release-it --preRelease=beta",
-    "build": "yarn clean && yarn build:commonjs && yarn build:esm && yarn build:typescript",
+    "build": "yarn clean && yarn build:commonjs && yarn build:esm && yarn build:types",
     "build:commonjs": "BABEL_ENV=cjs babel src --out-dir \"dist/commonjs\" --extensions .js,.ts --out-file-extension .js --source-maps --no-comments",
     "build:esm": "BABEL_ENV=esm babel src --out-dir \"dist/esm\" --extensions .js,.ts --out-file-extension .mjs  --source-maps --no-comments",
-    "build:typescript": "tsc --project tsconfig.release.json --outDir \"dist/types\""
+    "build:types": "tsc --project tsconfig.release.json --outDir \"dist/types\"",
+    "release": "release-it",
+    "release:beta": "release-it --preRelease=beta"
   },
   "keywords": [
     "markdown",
@@ -53,11 +53,11 @@
     "@babel/preset-env": "^7.25.4",
     "@babel/preset-typescript": "^7.24.7",
     "@callstack/eslint-config": "^15.0.0",
-    "@release-it/conventional-changelog": "^8.0.1",
-    "@size-limit/preset-small-lib": "^11.1.4",
+    "@release-it/conventional-changelog": "^9.0.0",
+    "@size-limit/preset-small-lib": "^11.1.6",
     "@types/jest": "^29.5.12",
     "babel-plugin-add-import-extension": "^1.6.0",
-    "del-cli": "^5.1.0",
+    "del-cli": "^6.0.0",
     "eslint": "^8.57.0",
     "eslint-config-prettier": "^8.10.0",
     "eslint-plugin-flowtype": "^8.0.3",
@@ -65,7 +65,7 @@
     "eslint-plugin-prettier": "^4.2.1",
     "jest": "^29.7.0",
     "prettier": "^2.8.8",
-    "release-it": "^17.6.0",
+    "release-it": "^17.10.0",
     "typescript": "^5.5.4"
   },
   "packageManager": "yarn@4.4.1",
@@ -84,6 +84,15 @@
     ]
   },
   "release-it": {
+    "hooks": {
+      "before:init": [
+        "yarn typecheck",
+        "yarn test",
+        "yarn lint"
+      ],
+      "after:bump": "yarn build",
+      "after:release": "echo Successfully released ${name} v${version} to ${repo.repository}."
+    },
     "git": {
       "commitMessage": "chore: release ${version}",
       "tagName": "v${version}"
@@ -92,11 +101,36 @@
       "publish": true
     },
     "github": {
-      "release": true
+      "release": true,
+      "releaseName": "v${version} (${date:yyyy-MM-dd})"
     },
     "plugins": {
       "@release-it/conventional-changelog": {
-        "preset": "angular"
+        "preset": {
+          "name": "conventionalcommits",
+          "types": [
+            {
+              "type": "feat",
+              "section": "✨ Features"
+            },
+            {
+              "type": "perf",
+              "section": "💨 Performance Improvements"
+            },
+            {
+              "type": "fix",
+              "section": "🐛 Bug Fixes"
+            },
+            {
+              "type": "chore(deps)",
+              "section": "🛠️ Dependency Upgrades"
+            },
+            {
+              "type": "docs",
+              "section": "📚 Documentation"
+            }
+          ]
+        }
       }
     }
   },

package/dist/commonjs/join.js

@@ -1,15 +0,0 @@
-"use strict";
-
-exports.joinBlocks = joinBlocks;
-exports.joinLines = joinLines;
-var _html = require("./html.js");
-function joinBlocks(blocks) {
-  return blocks.filter(Boolean).map(trimBlock).join('\n\n');
-}
-function joinLines(lines) {
-  return lines.filter(Boolean).join(_html.lineBreak);
-}
-function trimBlock(block) {
-  return block.replace(/^\n+|\n+$/g, '');
-}
-//# sourceMappingURL=join.js.map

package/dist/commonjs/join.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"join.js","names":["joinBlocks","blocks","filter","Boolean","map","trimBlock","join","joinLines","lines","lineBreak","block","replace"],"sources":["../../src/join.ts"],"sourcesContent":["import { lineBreak } from './html';\n\n/**\n * Join blocks of text into a single markdown document (string).\n *\n * @param blocks - The blocks of text to join.\n * @returns Markdown document string.\n */\nexport function joinBlocks(blocks: readonly string[]): string {\n  return blocks.filter(Boolean).map(trimBlock).join('\\n\\n');\n}\n\n/**\n * Join lines of text into a single paragraph string with line breaks.\n *\n * @param lines - The lines of text to join.\n * @returns Paragraph string.\n */\nexport function joinLines(lines: string[]) {\n  return lines.filter(Boolean).join(lineBreak);\n}\n\nfunction trimBlock(block: string): string {\n  return block.replace(/^\\n+|\\n+$/g, '');\n}\n"],"mappings":";;;;;AAQO,SAASA,UAAUA,CAACC,MAAyB,EAAU;EAC5D,OAAOA,MAAM,CAACC,MAAM,CAACC,OAAO,CAAC,CAACC,GAAG,CAACC,SAAS,CAAC,CAACC,IAAI,CAAC,MAAM,CAAC;AAC3D;AAQO,SAASC,SAASA,CAACC,KAAe,EAAE;EACzC,OAAOA,KAAK,CAACN,MAAM,CAACC,OAAO,CAAC,CAACG,IAAI,CAACG,eAAS,CAAC;AAC9C;AAEA,SAASJ,SAASA,CAACK,KAAa,EAAU;EACxC,OAAOA,KAAK,CAACC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC;AACxC","ignoreList":[]}

package/dist/esm/join.mjs

@@ -1,11 +0,0 @@
-import { lineBreak } from "./html.mjs";
-export function joinBlocks(blocks) {
-  return blocks.filter(Boolean).map(trimBlock).join('\n\n');
-}
-export function joinLines(lines) {
-  return lines.filter(Boolean).join(lineBreak);
-}
-function trimBlock(block) {
-  return block.replace(/^\n+|\n+$/g, '');
-}
-//# sourceMappingURL=join.mjs.map

package/dist/esm/join.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"join.mjs","names":["lineBreak","joinBlocks","blocks","filter","Boolean","map","trimBlock","join","joinLines","lines","block","replace"],"sources":["../../src/join.ts"],"sourcesContent":["import { lineBreak } from './html';\n\n/**\n * Join blocks of text into a single markdown document (string).\n *\n * @param blocks - The blocks of text to join.\n * @returns Markdown document string.\n */\nexport function joinBlocks(blocks: readonly string[]): string {\n  return blocks.filter(Boolean).map(trimBlock).join('\\n\\n');\n}\n\n/**\n * Join lines of text into a single paragraph string with line breaks.\n *\n * @param lines - The lines of text to join.\n * @returns Paragraph string.\n */\nexport function joinLines(lines: string[]) {\n  return lines.filter(Boolean).join(lineBreak);\n}\n\nfunction trimBlock(block: string): string {\n  return block.replace(/^\\n+|\\n+$/g, '');\n}\n"],"mappings":"SAASA,SAAS;AAQlB,OAAO,SAASC,UAAUA,CAACC,MAAyB,EAAU;EAC5D,OAAOA,MAAM,CAACC,MAAM,CAACC,OAAO,CAAC,CAACC,GAAG,CAACC,SAAS,CAAC,CAACC,IAAI,CAAC,MAAM,CAAC;AAC3D;AAQA,OAAO,SAASC,SAASA,CAACC,KAAe,EAAE;EACzC,OAAOA,KAAK,CAACN,MAAM,CAACC,OAAO,CAAC,CAACG,IAAI,CAACP,SAAS,CAAC;AAC9C;AAEA,SAASM,SAASA,CAACI,KAAa,EAAU;EACxC,OAAOA,KAAK,CAACC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC;AACxC","ignoreList":[]}

package/dist/types/join.d.ts

@@ -1,14 +0,0 @@
-/**
- * Join blocks of text into a single markdown document (string).
- *
- * @param blocks - The blocks of text to join.
- * @returns Markdown document string.
- */
-export declare function joinBlocks(blocks: readonly string[]): string;
-/**
- * Join lines of text into a single paragraph string with line breaks.
- *
- * @param lines - The lines of text to join.
- * @returns Paragraph string.
- */
-export declare function joinLines(lines: string[]): string;